home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 March / macformat-022.iso / Shareware City / Developers / HoW Developer’s Kit 1.2 / HoWSample / HoWSample Help / HoWSample Help.rsrc / STR#_1024.txt < prev    next >
Encoding:
Text File  |  1994-10-17  |  4.4 KB  |  255 lines
  1. 
  2.  
  3. , 
  4.  
  5. Ñ
  6.  
  7. Ñ
  8.  
  9. Ñ
  10.  
  11. Ñ
  12.  
  13. ¬ªHoWSample 1.2
  14.  
  15. »
  16.  
  17. October 17, 1994
  18.  
  19. »
  20.  
  21. 
  22.  
  23. √•Table of Contents
  24.  
  25. 
  26.  
  27. 
  28.  
  29. 
  30.  
  31. 
  32.  
  33. 
  34.  
  35. 
  36.  
  37. 
  38.  
  39. 
  40.  
  41. 
  42.  
  43. 
  44.  
  45.     
  46.  
  47. 
  48.  
  49.  
  50. 
  51.  
  52. 
  53.  
  54. 
  55.  
  56.  
  57. 
  58.  
  59. 
  60.  
  61. 
  62.  
  63. ‚åò
  64.  
  65. ‚áß
  66.  
  67. ‚å•
  68.  
  69. ⌃
  70.  
  71. 
  72.  
  73. 
  74.  
  75. 
  76.  
  77. 
  78.  
  79. 
  80.  
  81. 
  82.  
  83. 
  84.  
  85. 
  86.  
  87. 
  88.  
  89. 
  90.  
  91. Ë
  92.  
  93. Ë
  94.  
  95. √•Disclaimer and Copyright Notice
  96.  
  97. 
  98.  
  99. 
  100.  
  101. HoWSample is a minimal sample application, and doesn‚Äôt really do anything
  102.  
  103. useful, except that its help file (which you are reading) serves as the
  104.  
  105. manual for the Help on Wheels developer‚Äôs kit.  The source code provided
  106.  
  107. with HoWSample shows you how to make your application into a client of
  108.  
  109. the Help on Wheels help server application, just like this one.  This code is
  110.  
  111. provided on an as-is basis for your benefit, and is not warranted in any
  112.  
  113. way.  The author, Ross Brown, will not be responsible for any
  114.  
  115. consequence of the use of this application or its source code.
  116.  
  117. 
  118.  
  119. 
  120.  
  121. HoWSample is an AWOL Software Production, Copyright ¬© 1994 Ross
  122.  
  123. Brown.  All rights reserved.  Portions of the Help on Wheels developer‚Äôs
  124.  
  125. kit written by John Norstad are Copyright ¬© 1988, 1989, 1990,
  126.  
  127. Northwestern University.  You are free to use the source code provided in
  128.  
  129. any way you choose.  See the ‚ÄúDisclaimer and Copyright Notice‚Äù section
  130.  
  131. of the Help on Wheels help file for details about the copyright status of the
  132.  
  133. help server itself.
  134.  
  135. 
  136.  
  137. 
  138.  
  139. 
  140.  
  141. 
  142.  
  143. L
  144.  
  145. L
  146.  
  147. åOverview
  148.  
  149. 
  150.  
  151. 
  152.  
  153. Help on Wheels is a free help server which provides on-line help service
  154.  
  155. for client applications running on the same Macintosh computer.  It offers
  156.  
  157. its clients a simple, consistent user interface model, which includes client
  158.  
  159. indexing, a table of contents, and a flexible hypertext capability.  Client
  160.  
  161. applications are smaller than they would be if they provided their own
  162.  
  163. help interface, as they can ignore the difficult matters of displaying,
  164.  
  165. saving, and printing styled help text.
  166.  
  167. 
  168.  
  169. 
  170.  
  171. When you write a client application, you use a simple five-function
  172.  
  173. interface library, HoWLib, to communicate with the help server.  These
  174.  
  175. functions direct a small client engine which you link into your application.
  176.  
  177. Once registered, this engine tracks the help server, launching and
  178.  
  179. re-launching it as required.  It also detects ‚ÄúHelp events‚Äù sent by the
  180.  
  181. server when the user clicks on ‚Äúhot‚Äù hypertext buttons, and feeds them
  182.  
  183. back to you via a handler you provide.
  184.  
  185. 
  186.  
  187. When you release your product, you can freely include a copy of Help on
  188.  
  189. Wheels in the distribution, or direct users to a place where they can find a
  190.  
  191. copy.  The server requires no special installation.  If a user asks for help
  192.  
  193. from your application, and the help server is not present on any mounted
  194.  
  195. volume, the client engine offers to save the help text as a TeachText
  196.  
  197. document, and opens it for the user.
  198.  
  199. 
  200.  
  201. Your help text and pictures are stored in a standard, server-friendly
  202.  
  203. compiled form in one or more help files, of which only one is active at a
  204.  
  205. time.  If you want to ensure that help is always available, you may build
  206.  
  207. the help information into the application itself, so that the application file
  208.  
  209. is also the help file.  Otherwise, your help file is a separate document,
  210.  
  211. which can be stored separately, archived, or trashed.  Because your
  212.  
  213. separate help file is a Help on Wheels document, the user can open or print
  214.  
  215. it without opening your application, so there may be no need to provide
  216.  
  217. any other form of documentation in your package.
  218.  
  219. 
  220.  
  221. Because any application can be a client, Help on Wheels offers
  222.  
  223. background-only applications a handy method of interacting with the user,
  224.  
  225. more sophisticated than the Notification Manager.
  226.  
  227. 
  228.  
  229. Programs which are not applications (system extensions, Chooser
  230.  
  231. extensions, control panels, etc.) can also be documented using help files,
  232.  
  233. but cannot register with the server as applications do, because they are
  234.  
  235. not distinct processes under the Macintosh Operating System.  If you want
  236.  
  237. to offer an on-line help facility for such a program, you can add a Help
  238.  
  239. button, or detect the Help key at startup, and call a HoWLib function to tell
  240.  
  241. the server to open the help file.  This request will automatically wait for
  242.  
  243. startup to complete, if necessary.
  244.  
  245. 
  246.  
  247. Help on Wheels supports multilingual help files, selecting a language based
  248.  
  249. on the current System environment.
  250.  
  251. 
  252.  
  253. 
  254.  
  255.